<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="generator" content="JsDoc Toolkit" />

<title>JsDoc Reference - jowe_ui_2d_diam</title>
<style type="text/css">
body {font:13px Tahoma, Arial, Helvetica, sans-serif;width:900px}
.header {clear:both;background-color:#ccc;padding:8px}
h1 {font-size:150%;font-weight:bold;padding:0;margin:1em 0 0 .3em}
hr {border:none 0;border-top:1px solid #7F8FB1;height:1px;padding:5px 0 5px 0}
pre.code {display:block;padding:8px;border:1px dashed #ccc;background-color:lightYellow}
#index {margin-top:24px;float:left;width:160px;position:absolute;left:8px;background-color:#F3F3F3;padding:8px}
#content {margin-left:190px;width:700px}
.classList {list-style-type:none;padding:0;margin:0 0 0 8px;font-family:arial, sans-serif;font-size:1em;overflow:auto}
.classList li {padding:0;margin:0 0 8px 0}
.summaryTable {width:100%}
h1.classTitle {font-size:170%;line-height:130%}
h2 {font-size:110%}
caption, div.sectionTitle {background-color:#7F8FB1;color:#fff;font-size:2em;text-align:left;padding:5px 0px 5px 10px;border:1px #7F8FB1 solid;margin-top:2em}
div.sectionTitle {margin-bottom:8px 0 8px 0}
.summaryTable thead {display:none;}
.summaryTable td {vertical-align:top;padding:4px;border-bottom:1px #7F8FB1 solid;border-right:1px #7F8FB1 solid}
/*col#summaryAttributes {}*/
.summaryTable td.attributes {border-left:1px #7F8FB1 solid;width:140px;text-align:right;font-size:11px}
td.attributes, .fixedFont {color:#002EBE;font-family:"Courier New",Courier,monospace;font-size:1.1em;padding-bottom:0.7em}
.summaryTable td.nameDescription {text-align:left;font-size:13px;line-height:15px}
.summaryTable td.nameDescription, .description {padding:0.2em;margin-left:2em}
.summaryTable {margin-bottom:8px;}
ul.inheritsList {list-style:square;margin-left:20px;padding-left:0}
.detailList {margin-left:20px;line-height:15px}
.detailList dt {margin-left:20px;}
.detailList .heading {font-weight:bold;padding-bottom:6px;margin-left:0}
.light, td.attributes, .light a:link, .light a:visited {color:#777;font-style:italic}
.fineprint {text-align:center;font-size:10px}
</style>
</head>
<body>
<div id="header">
<em>This page is a part of the <a href="http://code.google.com/p/jowe/">jOWE</a> project - a javascript Opensource Word Engine</em>
<hr />
</div>
<div id="index">
	<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">

<li></li>

<li><a href="../symbols/CityMap.html">CityMap</a></li>

<li><a href="../symbols/HeightMap.html">HeightMap</a></li>

<li><a href="../symbols/jowe_ui_2d_diam.html">jowe_ui_2d_diam</a></li>

<li><a href="../symbols/jowe_ui_2d_hexa.html">jowe_ui_2d_hexa</a></li>

<li><a href="../symbols/jowe_ui_2d_pixel.html">jowe_ui_2d_pixel</a></li>

</ul>
<hr />
</div>
<div id="content">
	<h1 class="classTitle">
		
		Class jowe_ui_2d_diam
	</h1>
	<p class="description">
		
		
		Draws an map with diamond tiles.
	</p>
<!-- ============================== constructor summary ==================== -->			
	
	<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class jowe_ui_2d_diam.">
		<caption>Class Summary</caption>
		<thead>
			<tr>
				<th scope="col">Constructor Attributes</th>
				<th scope="col">Constructor Name and Description</th>
			</tr>
		</thead>
		<tbody>
			<tr>
				<td class="attributes">&nbsp;</td>
				<td class="nameDescription" >
					<div class="fixedFont">
						<b><a href="../symbols/jowe_ui_2d_diam.html#constructor">jowe_ui_2d_diam</a></b>(canvas_id, canvas_width, canvas_height, canvas_backcolor)
					</div>
					<div class="description">Draw a map from a given heightmap object in a canvas tag.</div>
				</td>
			</tr>
		</tbody>
	</table>
	
<!-- ============================== properties summary ===================== -->
	
<!-- ============================== methods summary ======================== -->
	
		
		
		<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class jowe_ui_2d_diam.">
			<caption>Method Summary</caption>
			<thead>
				<tr>
					<th scope="col">Method Attributes</th>
					<th scope="col">Method Name and Description</th>
				</tr>
			</thead>
			<tbody>
			
				<tr>
					<td class="attributes">&nbsp;</td>
					<td class="nameDescription">
						<div class="fixedFont"><b><a href="../symbols/jowe_ui_2d_diam.html#draw">draw</a></b>(items, angle, x_off, x_off, height, width, colors, alt, border)
						</div>
						<div class="description">This function draws an map with diamond tiles in the canvas.</div>
					</td>
				</tr>
			
				<tr>
					<td class="attributes">&lt;private&gt; &nbsp;</td>
					<td class="nameDescription">
						<div class="fixedFont"><b><a href="../symbols/jowe_ui_2d_diam.html#-pnpoly">pnpoly</a></b>(nvert, vertx, verty, testx, testy)
						</div>
						<div class="description">This function find if a point lies within a polygon.</div>
					</td>
				</tr>
			
			</tbody>
		</table>
		
		
	
<!-- ============================== events summary ======================== -->
	
<!-- ============================== constructor details ==================== -->		
	
	<div class="details"><a name="constructor"> </a>
		<div class="sectionTitle">
			Class Detail
		</div>
		<div class="fixedFont">
				<b>jowe_ui_2d_diam</b>(canvas_id, canvas_width, canvas_height, canvas_backcolor)
		</div>
		<div class="description">
			Draw a map from a given heightmap object in a canvas tag.
			
		</div>
		
			
				<dl class="detailList">
				<dt class="heading">Parameters:</dt>
				
					<dt>
						<span class="light fixedFont">{string}</span>  <b>canvas_id</b>
						
					</dt>
						<dd>Id of the canvas tag to be used to draw the map.</dd>
				
					<dt>
						<span class="light fixedFont">{number}</span>  <b>canvas_width</b>
						
					</dt>
						<dd>Width of the canvas.</dd>
				
					<dt>
						<span class="light fixedFont">{number}</span>  <b>canvas_height</b>
						
					</dt>
						<dd>Height of the canvas.</dd>
				
					<dt>
						<span class="light fixedFont">{string}</span>  <b>canvas_backcolor</b>
						<i>Optional, Default: "#000"</i>
					</dt>
						<dd>Background color to be used when drawing the canvas.</dd>
				
				</dl>
			
			
			
			
			
			
			
				<dl class="detailList">
				<dt class="heading">See:</dt>
				
					<dd>How to use the <a href="http://jowe.ouebfrance.com/examples-jowe-ui-2d-diam.html">jowe_ui_2d_diam</a> object?</dd>
				
				</dl>
			
	</div>
	
<!-- ============================== field details ========================== -->		
	
<!-- ============================== method details ========================= -->		
	
		<div class="sectionTitle">
			Method Detail
		</div>
		
			<a name="draw"> </a>
			<div class="fixedFont">
			
			<b>draw</b>(items, angle, x_off, x_off, height, width, colors, alt, border)
			</div>
			<div class="description">
				This function draws an map with diamond tiles in the canvas.
				
				
			</div>
			
				
					<dl class="detailList">
					<dt class="heading">Parameters:</dt>
					
						<dt>
							<span class="light fixedFont">{array}</span> <b>items</b>
							
						</dt>
						<dd>Array of vertices in the polygon.</dd>
					
						<dt>
							<span class="light fixedFont">{number}</span> <b>angle</b>
							
						</dt>
						<dd>Number containing the x-coordinates of the polygon's vertices.</dd>
					
						<dt>
							<span class="light fixedFont">{number}</span> <b>x_off</b>
							
						</dt>
						<dd>X-coordinate of the offset point.</dd>
					
						<dt>
							<span class="light fixedFont">{number}</span> <b>x_off</b>
							
						</dt>
						<dd>Y-coordinate of the offset point.</dd>
					
						<dt>
							<span class="light fixedFont">{number}</span> <b>height</b>
							
						</dt>
						<dd>Height of the diamond tiles.</dd>
					
						<dt>
							<span class="light fixedFont">{number}</span> <b>width</b>
							
						</dt>
						<dd>Width of the diamond tiles.</dd>
					
						<dt>
							<span class="light fixedFont">{array}</span> <b>colors</b>
							
						</dt>
						<dd>Array of color used to draw the map.</dd>
					
						<dt>
							<span class="light fixedFont">{number}</span> <b>alt</b>
							<i>Optional, Default: 0</i>
						</dt>
						<dd>Determines the style of the map (0 : diamond, 1 : skew, 2 : saw).</dd>
					
						<dt>
							<span class="light fixedFont">{number}</span> <b>border</b>
							<i>Optional, Default: 0.4</i>
						</dt>
						<dd>Defines the space between tiles.</dd>
					
					</dl>
				
				
				
				
				
				
				
			<hr />
		
			<a name="-pnpoly"> </a>
			<div class="fixedFont">&lt;private&gt; 
			<span class="light">{boolean}</span>
			<b>pnpoly</b>(nvert, vertx, verty, testx, testy)
			</div>
			<div class="description">
				This function find if a point lies within a polygon.
				
				
			</div>
			
				
					<dl class="detailList">
					<dt class="heading">Parameters:</dt>
					
						<dt>
							<span class="light fixedFont">{number}</span> <b>nvert</b>
							
						</dt>
						<dd>Number of vertices in the polygon.</dd>
					
						<dt>
							<span class="light fixedFont">{array}</span> <b>vertx</b>
							
						</dt>
						<dd>Array containing the x-coordinates of the polygon's vertices.</dd>
					
						<dt>
							<span class="light fixedFont">{array}</span> <b>verty</b>
							
						</dt>
						<dd>Array containing the y-coordinates of the polygon's vertices.</dd>
					
						<dt>
							<span class="light fixedFont">{number}</span> <b>testx</b>
							
						</dt>
						<dd>X-coordinate of the test point.</dd>
					
						<dt>
							<span class="light fixedFont">{number}</span> <b>testy</b>
							
						</dt>
						<dd>Y-coordinate of the test point.</dd>
					
					</dl>
				
				
				
				
				
					<dl class="detailList">
					<dt class="heading">Returns:</dt>
					
						<dd><span class="light fixedFont">{boolean}</span> </dd>
					
					</dl>
				
				
				
			
		
	
<!-- ============================== event details ========================= -->		
	
	<hr />
</div>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
Ludovic L. ~ jOWE project ~&nbsp;
&copy;2010-2012<br />
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Thu May 03 2012 13:40:30 GMT+0200 (CEST)
</div>
</body>
</html>
